home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 36 / Amiga Format CD36 (1999-01-22)(Future Publishing)(GB)[!][issue 1999-02].iso / -seriously_amiga- / sound / swomp / swomp.readme < prev    next >
Text File  |  1998-11-30  |  5KB  |  143 lines
  1. Short:    (Octa)MED player, MUI interface
  2. Author:   Stephen Williams (sw@nysa.u-net.com)
  3. Uploader: Stephen Williams (sw@nysa.u-net.com)
  4. Type:     mus/play
  5. Requires: MUI 3.8, OS2.x+
  6.  
  7.  
  8. Swomp 1.0, (c) 1998 Stephen Williams
  9. ====================================
  10.  
  11. I've had this program sitting around for about three months and not
  12. got around to releasing it.  Big Stuff has happened to me recently
  13. (i.e. moving house, starting a new job etc), so I never got around to
  14. writing a .guide for it.  I still haven't, so I thought I'd knock a
  15. .readme together that details the function and operation of this
  16. program, and get it put on to Aminet.  I spent Copious Hours on Swomp
  17. and don't want my time to be wasted.
  18.  
  19. Swomp (contraction of "Stephen Williams' OctaMED Player") is a little
  20. proggy I wrote because I wasn't happy with any of the OctaMED player
  21. programs around.  Specifically, I wanted something a lot like Teijo
  22. Kinnunen's player, but with a nicer GUI and savable preferences.
  23.  
  24.  
  25. Invocation
  26. ----------
  27.  
  28. Swomp can be started in the usual ways (double-click the icon, or
  29. click Swomp and shift-click the module, or make Swomp the module's
  30. Default Tool, or use the Shell, with or without the name of a mod as
  31. an argument).  If present, Swomp will utilize Georg Hoermann's
  32. xfdmaster.library (v36+) to allow the use of crunched modules.  Since
  33. xfdmaster.library automatically hooks into XPK if available, you can
  34. use an optimized sample cruncher like xpkSQSH to compress all your
  35. modules.
  36.  
  37. Swomp requires version 7 or above of medplayer.library,
  38. octaplayer.library and octamixplayer.library to be installed in LIBS:,
  39. which are supplied in this distribution.  In addition, you must have
  40. MUI 3.8 installed.  You can get MUI from Aminet.
  41.  
  42.  
  43. Operation
  44. ---------
  45.  
  46. Once loaded, Swomp will display it's GUI.  The window contains six
  47. elements:
  48.  
  49. 1/ "Module" string gadget: here you type the name of a module you wish
  50. to load and play.  There's a popup button to the right of the string
  51. gadget, you can click this to pop up an ASL file selector and select
  52. your chosen module that way.  A module starts playing as soon as it is
  53. loaded.
  54.  
  55. 2/ "Subsong" slider: if the module contains more than one song, you
  56. can select the song you wish to play using this.
  57.  
  58. 3/ "Play/Pause" button; this acts like the corresponding button on
  59. a CD player.  Press it to suspend playback, or resume a paused module.
  60.  
  61. 4/ "Stop" button; when clicked, this halts playback.  The module will
  62. begin again from the start when you click "Play".
  63.  
  64. 5/ Timer: this shows how long the current module has been playing for.
  65.  
  66. 6/ Channel usage: this shows how many sound channels the current song
  67. is using.  The figure will be between 4 and 8, or "Mix" for OctaMED
  68. Soundstudio modules.
  69.  
  70.  
  71. Menus
  72. -----
  73.  
  74. Swomp has two menus, "Project" and "Settings".  The items on the
  75. Project menu are as follows:
  76.  
  77.   Load Module...: Opens an ASL selector so you can pick a module to load.
  78.  
  79.   Play/Pause: Same as clicking the "Play/Pause" button.
  80.  
  81.   Stop: Same as clicking the "Stop" button.
  82.  
  83.   Annotation...: Displays any annotation text included in the currently
  84.   loaded module.
  85.  
  86.   About...: Gee, I wonder what this does :-)
  87.  
  88.   Quit: Hoses the current instance of Swomp.
  89.  
  90. The items on the Settins menu are these:
  91.  
  92.   Swomp: Opens Swomps prefs window (see below).
  93.  
  94.   MUI: Launches MUI prefs to allow tweaking of Swomp's GUI.
  95.  
  96.  
  97. The preferences window
  98. ----------------------
  99.  
  100. This window has four items:
  101.  
  102. 1/ High-Quality Mode: If checked, this option enabled high-quality
  103. playback mode for 5-8 channel modules.  Defaults to "off".
  104.  
  105. 2/ Mixing Frequency: This pop-up slider allows you to select the
  106. playback rate for OctaMED Soundstudio mods.  The default is 15,000Hz,
  107. Note that high settings may require the use of double-scanned
  108. screenmodes.
  109.  
  110. 3/ 14-Bit Mode: If checked, this option enables 14-bit mixing when
  111. playing OctaMED Soundstudio mods.
  112.  
  113. 4/ Save: This saves the settings in ENVARC: for Swomp to pick up next
  114. time it's invoked.  If you don't save, the settings will persist only
  115. for the current invocation of Swomp.  Settings take effect as soon as
  116. you make an adjustment.
  117.  
  118.  
  119. Credits
  120. -------
  121.  
  122. Whilst this is one of my better programs, the real quality coding was
  123. done by Teijo Kinnunen, who developed MED, OctaMED and OctaMED
  124. Soundstudio, and who was good enough to package the replay code in
  125. libraries, free for non-commercial use.  Thanks, Teijo!
  126.  
  127. Credit is due to Stefan Stuntz for the MUI system, without which Swomp
  128. would have had a less nice GUI.  Nice one, Stefan!  The Amiga
  129. community owes you a great debt of gratitude for MUI.
  130.  
  131. Georg Hoermann deserves credit for the xfdmaster decompression system,
  132. which Swomp utilizes to support crunched modules.  Great job, Georg!
  133.  
  134.  
  135. Outroduction
  136. ------------
  137.  
  138. Sorry that these aren't proper .guide docs, but they should suffice.
  139. If you have any comments on Swomp, please email me at the address at
  140. the top of this document.  Oh, and be sure to give my Web page a look
  141. (http://www.nysa.u-net.com/), you can find more little Amiga proglets
  142. by me at my site.
  143.